home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _comms / comms / _riscbbs / !RiscBBS / !Basics next >
Text File  |  1991-10-18  |  5KB  |  145 lines
  1.  
  2. A cryptic guide to the RiscBBS basics.
  3. --------------------------------------
  4.  
  5. When running from a floppy, make sure the disc is write ENABLED,
  6. because RiscBBS continuously opens and updates files!
  7.  
  8. Inside the System.Kernel directory are all the central files
  9. which RiscBBS relies upon:
  10.  
  11.    - Modem     : Modem-initialisation file. Run when RiscBBS
  12.                  starts up.
  13.  
  14.    - SysBBS    : The main (central) RiscBBS definition file.
  15.                  Actually controls how the system behaves (menus,
  16.                  bases, areas, ...). Edited by the sysop.
  17.  
  18.    - UserData  : The userdata file. May be deleted to get a new,
  19.                  'blank' system. Is created/maintained by the
  20.                  program itself.
  21.  
  22. It's the sysop's task to edit the SysBBS file to setup the BBS.
  23.  
  24.  
  25. In the System.EventTexts directory are the files that are shown
  26. (sent to the user) when a specific event occurs:
  27.  
  28.    - ChatEnd   : Shown when a chat ends.
  29.  
  30.    - ChatStart : Shown when a chat starts.
  31.  
  32.    - DayLimit  : Shown when a user's daily time-limit is reached.
  33.  
  34.    - Logoff    : Shown right before the line is dropped.
  35.  
  36.    - NewUser   : Shown when a new user logs on.
  37.  
  38.    - PostLogon : Shown when a user is fully logged on.
  39.  
  40.    - PreLogon  : Shown when a modem-connection is established.
  41.  
  42.    - TimeOut   : Shown when a user is inactive for 2 mins.
  43.  
  44. These files MUST not be present: if they are, they're shown.
  45.  
  46.  
  47. In the System.LogFiles directory are the loggings of the 
  48. !RiscBBS system:
  49.  
  50.    - Call_Log  : Logfile of all calls.
  51.  
  52.    - Error_Log : Logfile of any possible system-errors.
  53.  
  54.    - Event_Log : Logfile of the most important events.
  55.  
  56.    - Snoop_Log : Logfile of all output after an F4 keypress.
  57.  
  58. These logfiles may be deleted at any time (when they become too
  59. long). They are merely created for the sysop's convenience to
  60. watch the system's behaviour.
  61.  
  62.  
  63. In the Subtasks directory (may have another name) are the so
  64. called 'child tasks' and 'adjacent tasks'.
  65.  
  66. Examples of childtasks:
  67.  
  68.    - !Today    : Shows birthdays/events for a certain date.
  69.  
  70.    - !Breakout : An online ANSI game.
  71.  
  72. Examples of adjacent tasks:
  73.  
  74.    - !UserEdit : The RiscBBS User-Editor (MUST be present).
  75.                  Hotlinked with the RiscBBS server.
  76.  
  77.    - !Monitor  : An improved !Usage to monitor system load.
  78.  
  79. Adjacent tasks need not be written to communicate with RiscBBS,
  80. but child tasks should be, if they want to use RiscBBS's output
  81. and input channels. Edit the !Breakout.!RunImage for an example
  82. of this.
  83.  
  84.  
  85. In the BBS directory (may have another name) are the
  86. miscellaneous text-files, which are shown to the user.
  87. These files may be called from a menu option, or from within
  88. another such text-file (full recursion)!
  89. Just as the SysBBS system file, these files can have embedded
  90. command-scopes. Have a look at them to see how they work!
  91.  
  92.  
  93. In the Base directories (may have another name) are stored the
  94. message-files and user-uploads, together with some reference 
  95. files which are created/maintained by RiscBBS itself. It is
  96. enough for a 'base' directory to be 'created' (by the sysop) for
  97. RiscBBS's use.
  98. RiscBBS has its own 'filing-system': such that each msg and upload
  99. is stored with a serial number as its filename.
  100.  
  101. For local uploads (uploads by the sysop), just drag the files to
  102. be uploaded on the RiscBBS icon. A window will appear in which you
  103. can specify where the files should go etc. For a long description,
  104. drag a textfile (the long description) onto the 'Textfile'-icon.
  105.  
  106.  
  107. When RiscBBS is loaded (ie. it sits on the iconbar), and you
  108. subsequently change the SysBBS system file, you should afterwards
  109. click on the 'New System' item in the icon-menu. This causes
  110. RiscBBS to update its internal menu and other pointers.
  111.  
  112.  
  113. With a local logon, you can logoff in two ways:
  114. a) in the normal way, by selecting the Goodbye (logoff) options.
  115.    this is the preferred way!
  116. b) by closing the local logon window.
  117.  
  118.  
  119. The sysop should be aware of the fact that having the full-snoop
  120. window open puts a heavy load on the system. When not necessary,
  121. the window should be closed or dragged 'outside the screen'.
  122.  
  123.  
  124. Some function-keys when in full-snoop or local logon mode:
  125.  
  126.    F1 : Starts/ends chat with user.
  127.  
  128.    F4 : Starts/stops logging all output. (file LogFiles.Snoop_Log)
  129.  
  130.    F5 : Decrease user's level with 10.
  131.  
  132.    F6 : Increase user's level with 10.
  133.  
  134.    Ctrl-F1 : Immediately logoff current user.
  135.  
  136.  
  137. To get the hang of it all, study the various system/text files
  138. carefully and you should be able to make your own BBS setup.
  139.  
  140. I will supply the final version of RiscBBS with some decent
  141. documentation, but for the time being, coding comes first!
  142.  
  143.  
  144.                                        The author, Carl Declerck.
  145.